-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Microsoft.ProviderHub : Add new api-version 2021-05-01-preview #14249
Conversation
Hi, @sanjaiganesh Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L2426 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4118 |
|
'expeditedRollout' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L2435 |
|
'ResourceConcurrencyControlOption' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4099 |
|
'policy' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4102 |
|
'ResourceGraphConfiguration' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4115 |
|
'enabled' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4118 |
|
'apiVersion' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4121 |
|
'resourceConcurrencyControlOptions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4342 |
|
'resourceGraphConfiguration' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4348 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L2311 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L2593 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3493 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3579 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L3902 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4372 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L4604 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Operations_CreateOrUpdate' Request Model: 'OperationsPutContent' Response Model: 'OperationsContent' Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L769 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdate' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L1326 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdateNestedResourceTypeFirst' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#L1478 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2020-11-20/providerhub.json <---> new: preview/2021-05-01-preview/providerhub.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
[Staging] SDK Track2 Validation: 1 Errors, 5 Warnings failed [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
AutorestCore/Exception |
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"Error: Plugin pre-namer reported failure." |
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"The schema 'ResourceProviderManagement-resourceAccessRolesItem' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceProviderManagement-resourceAccessRolesItem" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"The schema 'ResourceProviderManifestProperties-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceProviderManifestProperties-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"The schema 'ResourceType-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceType-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"The schema 'ResourceProviderManifest-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/ResourceProviderManifest-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"The schema 'OperationsDefinition-properties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json#/components/schemas/OperationsDefinition-properties" |
|
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-05-01-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi @sanjaiganesh, Your PR has some issues. Please fix the CI sequentially by following the order of
|
azp /run |
ARM recommendation would be to model this as a string enum property like "rolloutType": { "Default", "Expedited" }. This type of property is easier for users to discover, learn, understand, and use. The values help convey the meaning. Also, if you use modelAsString: true, you can add enum values later without an API version change. Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json:2426 in ec20e1c. [](commit_id = ec20e1c, deletion_comment = False) |
ExpeditedRollout.Enabled : Agree on the enum flexibility. But this model is chosen to have an object/container to add more options around expedited rollout. We are not expecting more rollout types. Either regular or hotfix/expedited only. If rollout type is introduced, then we need to have another object like 'expeditedRolloutOptions' {} to capture any settings related to it. In reply to: 834895459 Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json:2426 in 47c67ce. [](commit_id = 47c67ce, deletion_comment = False) |
same here. ARG integration is either enabled or disabled. Not expecting more values in future. In reply to: 834897149 Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json:4118 in 47c67ce. [](commit_id = 47c67ce, deletion_comment = False) |
Sure, it's just a suggestion, not blocking. FTR, it's not only flexibility/futureproofing that makes enums better. They are also easier to understand, learn, and use as well. And it's the direction Azure API consistency is pointing as well: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html#common-issues-found-in-review. Please consider this bigger picture in future API work. In reply to: 834910361 Refers to: specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-05-01-preview/providerhub.json:4118 in 47c67ce. [](commit_id = 47c67ce, deletion_comment = False) |
@leni-msft could you please merge this PR ? |
…#14249) * initial commit establish base (previous stable version) * adding preview api * update right examples. prettier fix * adding concurrency & ARG properties * adding management * fixing management
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.